home *** CD-ROM | disk | FTP | other *** search
/ EnigmA Amiga Run 1995 November / EnigmA AMIGA RUN 02 (1995)(G.R. Edizioni)(IT)[!][issue 1995-11][Skylink CD].iso / earcd / util / text / miserpri.lha / MiserPrint / MiserPrint.doc < prev    next >
Text File  |  1995-08-22  |  19KB  |  538 lines
  1.                            MiserPrint V1.16
  2.                            ================
  3.  
  4.                      ****************************
  5.                      * This program is GIFTWARE *
  6.                      ****************************
  7.  
  8.                    Written by Heinz-Guenter Boettger
  9.                   GUI created with GadToolsBox V2.0c
  10.  
  11.               Comments, suggestions, bug reports etc. to
  12.                   hgb@pool.informatik.rwth-aachen.de
  13.  
  14.  
  15. 0. Important
  16. ============
  17.  
  18.   *********************************************************************
  19.   *       Starting with release V1.11, MiserPrint is 'Giftware'       *
  20.   *                                                                   *
  21.   * If  you like this program and will use it, you should consider to *
  22.   * send  me  a  litte (or big ;-) donation for my work (please don't *
  23.   * send cheques or money orders). If you can't afford to send me any * 
  24.   * donation you can write a picture postcard to                      *
  25.   *                                                                   *
  26.   *                      Heinz-Guenter Boettger                       *
  27.   *                         Roermonder Bahn 5                         *
  28.   *                           41844 Wegberg                           *
  29.   *                              Germany                              *
  30.   *********************************************************************
  31.  
  32. 0.1. Disclaimer
  33. ===============
  34. This  software comes with no warranty, either expressed or implied. The
  35. author  is  in no way responsible for any damage or loss that may occur
  36. due  to  direct  or  indirect usage of this software. Use this software
  37. entirely at your own risk.
  38.  
  39. 0.2. Copyright
  40. ==============
  41. This   software   is   freely   distributable,  BUT  all  programs  and
  42. documentation are copyright by Heinz-Guenter Boettger.
  43.  
  44. 0.3. Distribution
  45. =================
  46. Permission is given to include this program in a public archive (such as
  47. a BBS, FTP site or PD library (disk and CD-ROM versions)) providing that
  48. all  parts  of  the  original distribution are kept intact. These are as
  49. follows:
  50.  
  51.     MiserPrint.info
  52.     MiserPrint/MiserPrint
  53.     MiserPrint/MiserPrint.info
  54.     MiserPrint/MiserPrint.doc
  55.     MiserPrint/MiserPrint.doc.info
  56.     MiserPrint/MiserPrint.guide
  57.     MiserPrint/MiserPrint.guide.info
  58.     MiserPrint/Install
  59.     MiserPrint/Install.info
  60.     MiserPrint/MiserPrintPrefs/MiserPrint.prefs
  61.     MiserPrint/MiserPrintPrefs/Manual.prefs
  62.     MiserPrint/MiserPrintPrefs/Listing.prefs
  63.     MiserPrint/Icons.info
  64.     MiserPrint/Icons/MiserPrint_DG.info
  65.     MiserPrint/Icons/MiserPrint_PP.info
  66.  
  67. No charge may be made for this program, other than a reasonable copying
  68. fee,  and/or  the  price of the media. This fee _must not_ be more than
  69. US $3 or DM 4 for floppy disks and US 21$ or DM 30 for CD-ROMs.
  70.  
  71. Finally  if  you  wish to include MiserPrint on a disk magazine you are
  72. REQUIRED  to  get  the  author's  permission  FIRST.  Usually this will
  73. require  you  to  just  send  me  a  copy  of  the issue which contains
  74. MiserPrint free of charge.
  75.  
  76. This program may not be included or used in commercial programs unless
  77. by written permission from the author.
  78.  
  79. 1. Requirements
  80. ===============
  81. MiserPrint requires
  82.  
  83. - an Amiga with Kickstart V37 or higher
  84. - any printer that is _compatible_ to a Hewlett-Packard Deskjet 500
  85.  
  86. The  program  should work fine with the Hewlett-Packard Deskjet series
  87. and compatible printers too (e.g. PCL-printers or other ink-jets).
  88.  
  89. I have tested MiserPrint with a HP Deskjet 500.
  90.  
  91. 2. Installation
  92. ===============
  93. To install MiserPrint
  94.     - copy 'MiserPrint' to your utilities directory
  95.     - copy the 'MiserPrintPrefs' directory
  96.     - set the environment variable 'MiserPrintPrefsPath' to that
  97.       directory (the full path with 'MiserPrintPrefs'!, don't forget
  98.       to copy it to envarc:)
  99.       
  100. or 
  101.     -click the Install icon.
  102.  
  103. Denis  Galiana  and Peter Popanda sent me some icons. You can find them
  104. in the 'Icons' drawer.
  105.  
  106. 3. Introduction
  107. ===============
  108. MiserPrint is a print utility that puts up to 8 normal pages of text on
  109. one  sheet  of  paper.  You are able to save paper and time. MiserPrint
  110. uses  the  small  built-in  fonts  (Courier  and  Letter Gothic) of the
  111. HP-Deskjet or compatible printers.
  112.  
  113. 4. Using MiserPrint
  114. ===================
  115. MiserPrint  can  be  started  from a CLI or from the Workbench. When the
  116. program  starts  up,  the default values are set and MiserPrint.prefs is
  117. read.  After  that  the  commandline  arguments  or  the  tool types are
  118. evaluated and the main window is opened.
  119.  
  120. MiserPrint  tries to add an AppWindow if you are running the Workbench.
  121. An  AppIcon  is  also  available (see ICONIFY in the CLI section or the
  122. 'Iconify' command in the project menu).
  123.  
  124. 4.1. CLI
  125. --------
  126. To  start  MiserPrint  from CLI simply type its name and the parameters
  127. you  need.  You  can  use '?' to get the template. The program uses the
  128. defaults and the command line options override them.
  129.  
  130. Template:   FILE,ICONIFY/S,USLEGAL/S,USLETTER/S,BLOCK/K/N,COURIER/S,
  131.             LPI/K/N,PFF=PERMITFF/S,PESC=PERMITESC/S,DRAFT/S,
  132.             LQB=LQBOLD/S,DOUBLE/K,HEADER/K,FOOTER/K,SEPERATE/K,
  133.             BN=BLOCKNUMBER/K,TAB/K/N,TO/K,PREFS/K,PT=PRINTERTYPE/K,
  134.             ICONX/K/N,ICONY/K/N,WINDOWX/K/N,WINDOWY/K/N,PUBSCREEN/K,
  135.             PRTBUF/K/N
  136.  
  137. Most  of  them  are  switches,  which  are  explained  in the `Gadgets'
  138. section.
  139.  
  140.     FILE
  141.         The file that you want to print.
  142.  
  143.     ICONIFY
  144.         The  main window is not opened, only an appicon is displayed on
  145.         the  workbench.  Doubleclick  it and the main window is opened.
  146.         Drop  another  icon  on top of it, the window is opened and you
  147.         get the new filename in the string gadget.
  148.  
  149.     BLOCK <n>
  150.         n must be 1, 2 or 4.
  151.  
  152.     LPI <n>
  153.         n must be a number between 8 and 16.
  154.  
  155.     DOUBLE (ON|OFF)
  156.     HEADER (ON|OFF)
  157.     FOOTER (ON|OFF)
  158.     SEPERATE (ON|OFF)
  159.     BLOCKNUMBER (ON|OFF)
  160.         These  flags must be set to ON or OFF. The format of the header
  161.         and the footer can be changed in the string gadget of the GUI.
  162.  
  163.     TAB <n>
  164.         n must be a number between 1 and 10.
  165.  
  166.     TO <filename>
  167.         The filename must be a valid AmigaDOS one.
  168.  
  169.     PREFS <filename>
  170.         The filename must include the full path.
  171.     
  172.     PRINTERTYPE (HP_DESKJET|OTHER_INKJET)
  173.         Set the printer type to HP_DESKJET if your printer is a Hewlett
  174.         Packard. The printer takes the sheets from the bottom.
  175.         Other inkjets have a different paper feeding from the top side.
  176.         For  this reason the sequence of printing is wrong and you have
  177.         to change the type to OTHER_INKJET.
  178.  
  179.     ICONX <ix>
  180.     ICONY <iy>
  181.     WINDOWX <wx>
  182.     WINDOWY <wy>
  183.         The  position  of the the appicon and the main window. The icon
  184.         coordinates  of the commandline or tooltypes parameters and the
  185.         actual position of the window is saved to your prefs file.
  186.     
  187.     PUBSCREEN <name>
  188.         Name  of  public  screen for MiserPrint to open the windows and
  189.         requesters on. Try it eg. with DirOpus...
  190.  
  191.     PRTBUF <size>
  192.         The  size of the printer buffer in 'byte'. The default value is
  193.         1000  byte.  If the buffer is too large you'll get a timeout of
  194.         the printer device.
  195.  
  196. 4.2. Workbench
  197. --------------
  198. The  Workbench tool types for Miserprint are:
  199.  
  200.     ICONIFY, USLEGAL, USLETTER, BLOCK=<n>, COURIER, LPI=<n>,
  201.     PERMITFF, PERMITESC, DRAFT, LQBOLD, DOUBLE=(ON|OFF),
  202.     HEADER=(ON|OFF), FOOTER=(ON|OFF), SEPERATE=(ON|OFF),
  203.     BLOCKNUMBER=(ON|OFF), TAB=<n>, TO=<filename>, PREFS=<filename>,
  204.     PRINTERTYPE=(HP_DESKJET|OTHER_INKJET), ICONX=<ix>, ICONY=<iy>,
  205.     WINDOWX=<wx>, WINDOWY=<wy>, PUBSCREEN=<name>, PRTBUF=<size>
  206.  
  207. To start MiserPrint from Workbench
  208. - doubleclick its icon.
  209. - click the text file you wish to print and shift-doubleclick MiserPrint.
  210. - set the project icon of a text to MiserPrint and doubleclick it.
  211.  
  212. More details are in the `CLI' section.
  213.  
  214. 4.3. Gadgets
  215. ------------
  216.  
  217. The Option Gadgets
  218. ------------------
  219.  
  220.     'Papersize'
  221.         With  this  gadget  you  can select the papersize that is used.
  222.         (DIN  A4  is  the  default,  because it is the standard size in
  223.         Germany.)
  224.  
  225.     'Block'
  226.         You can choose between three text arrangements:
  227.         - 1x1: one big block
  228.         - 1x2: two blocks, which are formatted in two columns
  229.         - 2x2: four little blocks, normally four normal pages on one sheet
  230.  
  231.     'Font'
  232.         The HP-Deskjet 500 has two built-in nonproportional fonts:
  233.         - Courier (6 point, 20 cpi)
  234.         - LetterGothic (6 point, 24 cpi)
  235.  
  236.     'LPI'
  237.         A slider gadget allows you to select the lines per inch between
  238.         8 and 16.
  239.  
  240.     The  two text gadgets 'Lines' and 'Cols' show you the dimensions of
  241.     one block.
  242.     
  243.     'Select Pages'
  244.         After  a  file  scan  you are able to select the first and last
  245.         page  that  you  want to print. The text gadget below shows the
  246.         first  and last page.
  247.         
  248.         Both  sides  or  only the odd respectively the even ones can be
  249.         selected. !!! Don't blame me if something went wrong. !!!
  250.  
  251.     'Formfeed'
  252.         If this option is enabled, the text after a formfeed is printed
  253.         on a new block.
  254.  
  255.     'ESC'
  256.         With  this option you can print some ANSI-ESC-sequences. I have
  257.         implemented  italics,  underline  and  boldface. The others are
  258.         filtered out.
  259.  
  260.     'Quality'
  261.         Three qualities can be selected:
  262.         - Draft: the fastest print
  263.         - LQ: my favourite mode
  264.         - LQBold: perhaps somebody will use it
  265.  
  266.     'Double'
  267.         This  option  enables the printing on both sides of the sheets,
  268.         so  that you can print 8 normal pages on one sheet (if block is
  269.         set  to  4).  First  the  even  pagenumbers are printed, then a
  270.         requester invites you to rotate the sheets before the odd pages
  271.         are   printed.  If  your  printout  is  redirected  to  a  file
  272.         MiserPrint  saves  the even pagenumbers to <filename>.1 and the
  273.         odd  ones  to  <filename>.2,  you  must  copy the files in this
  274.         sequence  to par: or ser: for a later printout. Don't copy them
  275.         to prt:!!!
  276.  
  277.     'Tab'
  278.         The  'getline'  function  of MiserPrint exchanges the tabs with
  279.         the  number  of  spaces  you entered in the tab gadget, because
  280.         MiserPrint  can't  use the tabulators of the printer. Otherwise
  281.         you get a wrong formatted printout.
  282.  
  283.     'Header'
  284.     'Footer'
  285.         A  header  or  footer  will  be printed on every sheet. You can
  286.         define  the  look of them. It supports some printf- or tex-like
  287.         expressions:
  288.  
  289.         %f      the filename without the path
  290.         %d1     the current date (15-Sep-93)
  291.         %d2     the current date (15.09.93)
  292.         %d3     the current date (09/15/93)
  293.         %t1     the current time (17:25)
  294.         %t2     the current time (05:25 PM)
  295.         %n      the pagenumber
  296.         %tn     the total number of pages
  297.         \hfill  fills  a  line  with spaces until the line has the full
  298.                 length
  299.  
  300.         Examples:
  301.         
  302.         "%f \hfill %n"
  303.         "%f \hfill %n / %nt"
  304.         "%f \hfill %d1 \hfill %t1 \hfill %n"
  305.         "\hfill - %n - \hfill"
  306.         "\hfill %n"
  307.  
  308.     'Seperate'
  309.         You  can  print a thin horizontal line between the blocks. This
  310.         option can only be used with the 2x2 blocks.
  311.  
  312.     'Block #'
  313.         On  the  bottom  of each block the number of this block will be
  314.         printed.
  315.  
  316. The String Gadgets
  317. ------------------
  318.  
  319.     'Filename'
  320.         You  can  select  a  file  by  clicking  the  getfile  image (a
  321.         filerequester  appears)  or  by  entering  the  filename in the
  322.         string gadget.
  323.  
  324.     'Port'
  325.         The  cycle  gadget allows you to print directly to your printer
  326.         (your  printer  preferences are used) or to a file. The getfile
  327.         image  and  the  string gadget are only activ when the printout
  328.         to a file is selected.
  329.  
  330. The Action Gadgets
  331. ------------------
  332.  
  333.     'Edit'
  334.         To  edit  the  file  you  can click this button and the command
  335.         'c:ed <filename>' is executed. You can also set the environment
  336.         variable  EDITOR to your preferable editor. I have done this by
  337.         'setenv EDITOR tools:ed -sticky' to use CygnusEd.
  338.     
  339.     'FileInfo'
  340.         The  file  is  scanned  and a requester shows some informations
  341.         about it.
  342.     
  343.     'Preview'
  344.         A  preview window is opened and the last page is displayed. You
  345.         can  move through the document with the four buttons on the top
  346.         or  with  the  cursor keys. Click the closing gadget or use the
  347.         ESC key to exit the preview.
  348.     
  349.     'Print'
  350.         If this button is clicked, the file will be printed.
  351.  
  352.     The  'FileInfo'  and 'Print' command can be aborted by clicking the
  353.     closing gadget.
  354.  
  355.     MiserPrint  doesn't  copy  the  whole file to memory but stores the
  356.     file  positions of the pages in a list. I chose this method to save
  357.     memory.
  358.  
  359. 4.4. Menu
  360. ---------
  361.  
  362. Project
  363. -------
  364.  
  365.     'Open Config...'
  366.         This command is used to load an old configuration.
  367.  
  368.     'Save Config...'
  369.         You can save your actual configuration with this command.
  370.  
  371.     'About'
  372.         Just try it.
  373.  
  374.     'Iconify'
  375.         The  main  window  is closed and an appicon is displayed on the
  376.         workbench (see `CLI' section).
  377.  
  378.     'Quit'
  379.         If  you want to exit the program, execute this command or click
  380.         the closing gadget.
  381.  
  382. Edit
  383. ----
  384.  
  385.     'Reset to defaults'
  386.         My defaults are used.
  387.  
  388.     'Last Saved'
  389.         Resets the configuration to the last saved one.
  390.  
  391.     'Restore'
  392.         MiserPrint uses the configuration on startup.
  393.  
  394. Settings
  395. --------
  396.  
  397.     'HP Deskjet'
  398.         The  checkmark is set if your printer is a Hewlett Packard. The
  399.         printer takes the sheets from the bottom.
  400.         Other inkjets have a different paper feeding from the top side.
  401.         For  this reason the sequence of printing is wrong and you have
  402.         to toggle the checkmark.
  403.  
  404. 5. Acknowledgments
  405. ==================
  406. Thanks to the following people:
  407.  
  408. - Matt Dillon for DICE.
  409.  
  410. - Jan  van  den  Baard  for  GadToolsBox,  which  was  used  to  design
  411.   MiserPrint's GUI.
  412.  
  413. - Stephan Sürken for Text2Guide.
  414.  
  415. - Alexander Aulbach for beta testing and some good ideas.
  416.  
  417. - Denis Galiana and Peter Popanda for beta testing, some ideas and the
  418.   nice icons.
  419.  
  420. - Peter Simons for mailing me some mungwall and enforcer hits.
  421.  
  422. - The  users  of MiserPrint who send me bug reports or suggestions.
  423.   Thanks for your picture postcards, letters and donations.
  424.  
  425. 6. History
  426. ==========
  427.  
  428. V1.16   Removed a bug in a print function. Double sided printing caused
  429.         some trouble with formfeeds.
  430.         (bug report: Peter Popanda)
  431.         
  432.         Now the printer buffer can get any size. The timeout problem of
  433.         the  printer device with DJ+ and some compatible printers (e.g.
  434.         NEC) are past now. Reduce the printer buffer size to 1-100 Byte.
  435.         (Hi Peter, I hope your problem is finally solved!!!)
  436.         
  437.         The system font is used instead of the screen font.
  438.         
  439.         The old preferences files aren't longer valid. MiserPrint reads
  440.         only the IFF configuration files. If anybody has loaded a normal
  441.         text file as a preferences file, MiserPrint can show you a nice
  442.         guru meditation after the next command (e.g. preview).
  443.         Changed the menus 'Open...' to 'Open Config...' 'Save As...' to
  444.         'Save Config...' and the titles of the file requesters.
  445.         (bug report: Paul Boven)
  446.  
  447. V1.15   Added 'PUBSCREEN' and 'PRTBUF' options.
  448.         
  449.         MiserPrint reads the environment variable 'MiserPrintPrefsPath'
  450.         to find the preferences files.
  451.  
  452. V1.14   The 'PREFS' Workbench tooltype didn't work correctly.
  453.         (bug report: Mark Gotz)
  454.         
  455.         Changed  the NewLookMenu handling. Menu background and text had
  456.         the same color under some circumstances (both 2.x and 3.x).
  457.         (bug report: Anthony J. Moringello and Rolf Damm)
  458.         
  459.         The  total number of pages '%tn' are available in the header or
  460.         footer string.
  461.         (suggestion: Frank Tischendorf) 
  462.  
  463. V1.13   Did you ever want to print only the even or odd pages?
  464.         (suggestion: Denis Galiana and Peter Popanda)
  465.  
  466.         Modified the print functions and added the printer type option.
  467.         (suggestion: Peter Popanda)
  468.  
  469.         Replaced a command that caused trouble with non-HP-printers.
  470.  
  471.         Some minor modifications.
  472.  
  473. V1.12   The  last  line of text wasn't printed if there was only an EOF
  474.         and no linefeed in this line.
  475.         (bug report: Robert Hamberger)
  476.  
  477.         After the printer has finished printing it is reseted.
  478.         (suggestion: Tom Duncan)
  479.  
  480.         Added AppWindow and AppIcon.
  481.         (suggestion: Denis Galiana)
  482.  
  483.         Fixed a bug in my memory allocation function.
  484.  
  485.         Added IconX, IconY, WindowX and WindowY.
  486.  
  487. V1.11   Removed the 'NOGUI' switch in the CLI. Has anybody used it?
  488.         
  489.         I found a bug in the IFF read function and removed it.
  490.  
  491.         There were one mungwall and two enforcer hits in a beta version.
  492.         (bug report: Peter Simons)
  493.  
  494. V1.10   NOT RELEASED!
  495.  
  496.         Removed the 'Really quit MiserPrint?' requester.
  497.     
  498.         I  forgot  to  take an empty page of paper, if you selected the
  499.         double  mode  and  there  was  an odd number of pages. For this
  500.         reason the sequence of the printout was wrong.
  501.         (bug report: Ulrich Zukowski)
  502.         
  503.         If  you  click  the  formfeed or double gadget the file will be
  504.         scanned the next time again.
  505.         (bug report and suggestion: Ulrich Zukowski)
  506.         
  507.         MiserPrint  uses the 'printer.device'. There is a timeout, e.g.
  508.         if your printer is offline or out of paper. You are able to use
  509.         a printer spooler.
  510.         (suggestion: Alexander Aulbach)
  511.         
  512.         I  changed  the  print  functions,  so  that  you  can abort it
  513.         quicker.
  514.         
  515.         The ANSI-ESC-sequence "<esc>[0m" selects the normal font.
  516.         (suggestion: Ulrich Zukowski)
  517.         
  518.         Have  you ever tried to print some underlined lines? The result
  519.         wasn't nice. I corrected these functions.
  520.         
  521.         Now you can print a footer.
  522.         (suggestion: Denis Galiana)
  523.         
  524.         MiserPrint stores its data in an IFF file, but it reads the old
  525.         configuration files too.
  526.         
  527.         You are able to choose the pages you want to (re)print.
  528.         (suggestion: Denis Galiana)
  529.  
  530.         A  horizontal  seperation line and the number of each block can
  531.         be printed.
  532.         (suggestion: Marcel Duruflé)
  533.  
  534. V1.01   There was a bug in the requester of the doublesided printout.
  535.         (bug report: Alexander Aulbach and Ulrich Zukowski)
  536.  
  537. V1.0    First release.
  538.